#pragma once
#include "stdafx.h"
//-------------------------------------------------------------------------------------------------
//ProcParamsOutputs.h  - Output Parameter collection for Image Processing Steps           
//-------------------------------------------------------------------------------------------------
//FreeBSD License
//Copyright 2012 Will Stott All rights reserved.
//
//Redistribution and use in source and binary forms, with or without modification, are
//permitted provided that the following conditions are met:
//
//   1. Redistributions of source code must retain the above copyright notice, this list of
//      conditions and the following disclaimer.
//
//   2. Redistributions in binary form must reproduce the above copyright notice, this list
//      of conditions and the following disclaimer in the documentation and/or other materials
//      provided with the distribution.
//
//THIS SOFTWARE IS PROVIDED BY Will Stott ``AS IS'' AND ANY EXPRESS OR IMPLIED
//WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
//FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Will Stott OR
//CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
//SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
//ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
//NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
//ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
//The views and conclusions contained in the software and documentation are those of the
//authors and should not be interpreted as representing official policies, either expressed
//or implied, of Will Stott.
//
//----Authors--------------------------------------------------------------------------------------
//created by: will.stott@ucl.ac.uk Feb 2012
//
//----Comments-------------------------------------------------------------------------------------
//
//-------------------------------------------------------------------------------------------------
#ifdef PLUGINICPROCSTEPS_EXPORTS
#define PLUGINICPROCSTEPS_API __declspec(dllexport)
#else
#define PLUGINICPROCSTEPS_API __declspec(dllimport)
#endif

#include "procparams.h"

class PLUGINICPROCSTEPS_API ProcParamsOutputs : public ProcParams
{
public:
	static const char * const xmlOutputs;
	static const char * const xmlParamNameResult;
	static const char * const xmlParamNameScore;

	static const int ResultInvalid = -1;	//result not found in param set 
	static const int ResultNotSet = 1;		//initial value set when param added to param set
	static const int ResultScoreFail = 2;	//only for analysis set, if the result was ResultOK but Score < passScore set when Score param added to param set
	static const int ResultOK = 0;			//result set by proc step
	static const double ScoreInvalid;		//score not found in param set, see .cpp for value

public:
	ProcParamsOutputs(TiXmlElement *stepXml);
	ProcParamsOutputs(const ProcParamsOutputs *params);
	ProcParamsOutputs(void);
	virtual ~ProcParamsOutputs(void);

	bool		SetParamValue(const char *Name, int Value);			//param value can only be set for output parameter
	bool		SetParamValue(const char *Name, double Value);
	bool		SetParamValue(const char *Name, const char *Value);
	bool		SetScore(double Value);
	bool		SetResultCode(int result);

	virtual bool					IsValid();
	virtual bool					Validate();
	virtual bool					IsAnalysisSet();		//

	bool		IsResultOK();
	int			GetResultCode();
	double		GetScore();

};

//-------------------------------------------------------------------------------------------------
//			E N D   O F   F I L E
//-------------------------------------------------------------------------------------------------